Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the repository documentation and examples to treat Decimal as the canonical arbitrary-precision decimal type name (with BigDecimal/BDec remaining as aliases), alongside a docs folder re-organization and a version bump to 0.10.0.
Changes:
- Rename the core arbitrary-precision decimal struct to
Decimaland keepBigDecimal/BDecas aliases. - Refresh docs/readmes/examples to consistently present
Decimalas the primary name and update import guidance. - Bump
pixi.toml(and referenced docs) from0.9.0→0.10.0, add internal docs, and remove the olddocs/api.md.
Reviewed changes
Copilot reviewed 12 out of 16 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| src/decimo/bigdecimal/bigdecimal.mojo | Makes Decimal the canonical struct name and adjusts aliasing + messaging. |
| python/README.md | Updates Python-facing docs to refer to Decimal and simplifies the status table. |
| pixi.toml | Bumps package version to 0.10.0. |
| examples/examples_on_decimal128.mojo | Adds Decimal128 usage examples. |
| examples/examples_on_bigint.mojo | Adds BigInt usage examples. |
| examples/examples_on_bigdecimal.mojo | Updates examples to use Decimal(...) directly. |
| docs/user_manual.md | Re-organizes TOC/sections and updates naming and version references. |
| docs/todo.md | Updates to-do items for Decimal naming and formatting. |
| docs/readme_zht.md | Updates ZH-TW readme wording/alias ordering for Decimal. |
| docs/readme_unreleased.md | Updates unreleased readme for 0.10.0, alias lists, and naming. |
| docs/plans/todo.md | Adds a re-homed TODO document under docs/plans/. |
| docs/internal/v0.8.0_benchmark_report.md | Adds an internal benchmark report document. |
| docs/internal/internal_notes.md | Adds internal notes and references from benches. |
| docs/api.md | Removes the old API reference document. |
| benches/cli/bench_cli.sh | Updates internal-notes link path after docs re-org. |
| README.md | Updates main README to present Decimal as the primary name and bumps wording accordingly. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
forfudan
changed the title
Decimal to the main struct name
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the documents and re-organize the "docs" folder.